<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: ReferenceSchemaField.html 842 2015-03-07 18:20:42Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb.schema;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.util.SortedSet;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.util.TreeSet;<a name="line.11"></a>
<span class="sourceLineNo">012</span><a name="line.12"></a>
<span class="sourceLineNo">013</span>import javax.xml.stream.XMLStreamException;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import javax.xml.stream.XMLStreamReader;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import javax.xml.stream.XMLStreamWriter;<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>import org.jsimpledb.core.DeleteAction;<a name="line.17"></a>
<span class="sourceLineNo">018</span>import org.jsimpledb.core.FieldType;<a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.jsimpledb.core.InvalidSchemaException;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.jsimpledb.util.Diffs;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>/**<a name="line.22"></a>
<span class="sourceLineNo">023</span> * A reference field in a {@link SchemaObjectType}.<a name="line.23"></a>
<span class="sourceLineNo">024</span> */<a name="line.24"></a>
<span class="sourceLineNo">025</span>public class ReferenceSchemaField extends SimpleSchemaField {<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>    private DeleteAction onDelete;<a name="line.27"></a>
<span class="sourceLineNo">028</span>    private boolean cascadeDelete;<a name="line.28"></a>
<span class="sourceLineNo">029</span>    private SortedSet&lt;Integer&gt; objectTypes;<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>    public ReferenceSchemaField() {<a name="line.31"></a>
<span class="sourceLineNo">032</span>        this.setType(FieldType.REFERENCE_TYPE_NAME);<a name="line.32"></a>
<span class="sourceLineNo">033</span>        this.setIndexed(true);<a name="line.33"></a>
<span class="sourceLineNo">034</span>    }<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span>    /**<a name="line.36"></a>
<span class="sourceLineNo">037</span>     * Get the desired behavior when an object referred to by this field is deleted.<a name="line.37"></a>
<span class="sourceLineNo">038</span>     *<a name="line.38"></a>
<span class="sourceLineNo">039</span>     * @return desired behavior when a referenced object is deleted<a name="line.39"></a>
<span class="sourceLineNo">040</span>     */<a name="line.40"></a>
<span class="sourceLineNo">041</span>    public DeleteAction getOnDelete() {<a name="line.41"></a>
<span class="sourceLineNo">042</span>        return this.onDelete;<a name="line.42"></a>
<span class="sourceLineNo">043</span>    }<a name="line.43"></a>
<span class="sourceLineNo">044</span>    public void setOnDelete(DeleteAction onDelete) {<a name="line.44"></a>
<span class="sourceLineNo">045</span>        this.onDelete = onDelete;<a name="line.45"></a>
<span class="sourceLineNo">046</span>    }<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span>    /**<a name="line.48"></a>
<span class="sourceLineNo">049</span>     * Determine whether the referred-to object should be deleted when an object containing this field is deleted.<a name="line.49"></a>
<span class="sourceLineNo">050</span>     *<a name="line.50"></a>
<span class="sourceLineNo">051</span>     * @return whether deletion should cascade to the referred-to object<a name="line.51"></a>
<span class="sourceLineNo">052</span>     */<a name="line.52"></a>
<span class="sourceLineNo">053</span>    public boolean isCascadeDelete() {<a name="line.53"></a>
<span class="sourceLineNo">054</span>        return this.cascadeDelete;<a name="line.54"></a>
<span class="sourceLineNo">055</span>    }<a name="line.55"></a>
<span class="sourceLineNo">056</span>    public void setCascadeDelete(boolean cascadeDelete) {<a name="line.56"></a>
<span class="sourceLineNo">057</span>        this.cascadeDelete = cascadeDelete;<a name="line.57"></a>
<span class="sourceLineNo">058</span>    }<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span>    /**<a name="line.60"></a>
<span class="sourceLineNo">061</span>     * Get the object types this field is allowed to reference, if so restricted.<a name="line.61"></a>
<span class="sourceLineNo">062</span>     *<a name="line.62"></a>
<span class="sourceLineNo">063</span>     * @return storage IDs of allowed object types, or null if there is no restriction<a name="line.63"></a>
<span class="sourceLineNo">064</span>     */<a name="line.64"></a>
<span class="sourceLineNo">065</span>    public SortedSet&lt;Integer&gt; getObjectTypes() {<a name="line.65"></a>
<span class="sourceLineNo">066</span>        return this.objectTypes;<a name="line.66"></a>
<span class="sourceLineNo">067</span>    }<a name="line.67"></a>
<span class="sourceLineNo">068</span>    public void setObjectTypes(SortedSet&lt;Integer&gt; objectTypes) {<a name="line.68"></a>
<span class="sourceLineNo">069</span>        this.objectTypes = objectTypes;<a name="line.69"></a>
<span class="sourceLineNo">070</span>    }<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span>    @Override<a name="line.72"></a>
<span class="sourceLineNo">073</span>    void validate() {<a name="line.73"></a>
<span class="sourceLineNo">074</span>        super.validate();<a name="line.74"></a>
<span class="sourceLineNo">075</span>        if (!FieldType.REFERENCE_TYPE_NAME.equals(this.getType())) {<a name="line.75"></a>
<span class="sourceLineNo">076</span>            throw new InvalidSchemaException("invalid " + this + ": reference fields must have type `"<a name="line.76"></a>
<span class="sourceLineNo">077</span>              + FieldType.REFERENCE_TYPE_NAME + "'");<a name="line.77"></a>
<span class="sourceLineNo">078</span>        }<a name="line.78"></a>
<span class="sourceLineNo">079</span>        if (!this.isIndexed())<a name="line.79"></a>
<span class="sourceLineNo">080</span>            throw new IllegalArgumentException("invalid " + this + ": reference fields must always be indexed");<a name="line.80"></a>
<span class="sourceLineNo">081</span>        if (this.onDelete == null)<a name="line.81"></a>
<span class="sourceLineNo">082</span>            throw new InvalidSchemaException("invalid " + this + ": no delete action specified");<a name="line.82"></a>
<span class="sourceLineNo">083</span>    }<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span>    @Override<a name="line.85"></a>
<span class="sourceLineNo">086</span>    public &lt;R&gt; R visit(SchemaFieldSwitch&lt;R&gt; target) {<a name="line.86"></a>
<span class="sourceLineNo">087</span>        return target.caseReferenceSchemaField(this);<a name="line.87"></a>
<span class="sourceLineNo">088</span>    }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span>    @Override<a name="line.90"></a>
<span class="sourceLineNo">091</span>    boolean isCompatibleWithInternal(AbstractSchemaItem that0) {<a name="line.91"></a>
<span class="sourceLineNo">092</span>        final ReferenceSchemaField that = (ReferenceSchemaField)that0;<a name="line.92"></a>
<span class="sourceLineNo">093</span>        if (!super.isCompatibleWithInternal(that))<a name="line.93"></a>
<span class="sourceLineNo">094</span>            return false;<a name="line.94"></a>
<span class="sourceLineNo">095</span>        if (!this.onDelete.equals(that.onDelete))<a name="line.95"></a>
<span class="sourceLineNo">096</span>            return false;<a name="line.96"></a>
<span class="sourceLineNo">097</span>        if (this.cascadeDelete != that.cascadeDelete)<a name="line.97"></a>
<span class="sourceLineNo">098</span>            return false;<a name="line.98"></a>
<span class="sourceLineNo">099</span>        if (!(this.objectTypes != null ? this.objectTypes.equals(that.objectTypes) : that.objectTypes == null))<a name="line.99"></a>
<span class="sourceLineNo">100</span>            return false;<a name="line.100"></a>
<span class="sourceLineNo">101</span>        return true;<a name="line.101"></a>
<span class="sourceLineNo">102</span>    }<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span>// DiffGenerating<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span>    @Override<a name="line.106"></a>
<span class="sourceLineNo">107</span>    public Diffs differencesFrom(SimpleSchemaField other) {<a name="line.107"></a>
<span class="sourceLineNo">108</span>        final Diffs diffs = new Diffs(super.differencesFrom(other));<a name="line.108"></a>
<span class="sourceLineNo">109</span>        if (!(other instanceof ReferenceSchemaField)) {<a name="line.109"></a>
<span class="sourceLineNo">110</span>            diffs.add("change type from " + other.getClass().getSimpleName() + " to " + this.getClass().getSimpleName());<a name="line.110"></a>
<span class="sourceLineNo">111</span>            return diffs;<a name="line.111"></a>
<span class="sourceLineNo">112</span>        }<a name="line.112"></a>
<span class="sourceLineNo">113</span>        final ReferenceSchemaField that = (ReferenceSchemaField)other;<a name="line.113"></a>
<span class="sourceLineNo">114</span>        if (!(this.onDelete != null ? this.onDelete.equals(that.onDelete) : that.onDelete == null))<a name="line.114"></a>
<span class="sourceLineNo">115</span>            diffs.add("changed on-delete action from " + that.onDelete + " to " + this.onDelete);<a name="line.115"></a>
<span class="sourceLineNo">116</span>        if (this.cascadeDelete != that.cascadeDelete)<a name="line.116"></a>
<span class="sourceLineNo">117</span>            diffs.add("changed cascade delete from " + that.cascadeDelete + " to " + this.cascadeDelete);<a name="line.117"></a>
<span class="sourceLineNo">118</span>        if (!(this.objectTypes != null ? this.objectTypes.equals(that.objectTypes) : that.objectTypes == null))<a name="line.118"></a>
<span class="sourceLineNo">119</span>            diffs.add("changed allowed object type storage IDs from " + that.objectTypes + " to " + this.objectTypes);<a name="line.119"></a>
<span class="sourceLineNo">120</span>        return diffs;<a name="line.120"></a>
<span class="sourceLineNo">121</span>    }<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span>// XML Reading<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span>    @Override<a name="line.125"></a>
<span class="sourceLineNo">126</span>    void readAttributes(XMLStreamReader reader, int formatVersion) throws XMLStreamException {<a name="line.126"></a>
<span class="sourceLineNo">127</span>        super.readAttributes(reader, formatVersion);<a name="line.127"></a>
<span class="sourceLineNo">128</span>        final String text = this.getAttr(reader, ON_DELETE_ATTRIBUTE, false);<a name="line.128"></a>
<span class="sourceLineNo">129</span>        final DeleteAction action;<a name="line.129"></a>
<span class="sourceLineNo">130</span>        if (text != null) {<a name="line.130"></a>
<span class="sourceLineNo">131</span>            if ((action = Enum.valueOf(DeleteAction.class, text)) == null) {<a name="line.131"></a>
<span class="sourceLineNo">132</span>                throw new XMLStreamException("invalid value `" + text<a name="line.132"></a>
<span class="sourceLineNo">133</span>                  + " for \"" + ON_DELETE_ATTRIBUTE.getLocalPart() + "\" attribute in " + this, reader.getLocation());<a name="line.133"></a>
<span class="sourceLineNo">134</span>            }<a name="line.134"></a>
<span class="sourceLineNo">135</span>        } else<a name="line.135"></a>
<span class="sourceLineNo">136</span>            action = DeleteAction.EXCEPTION;<a name="line.136"></a>
<span class="sourceLineNo">137</span>        this.setOnDelete(action);<a name="line.137"></a>
<span class="sourceLineNo">138</span>        final Boolean cascadeDeleteAttr = this.getBooleanAttr(reader, CASCADE_DELETE_ATTRIBUTE, false);<a name="line.138"></a>
<span class="sourceLineNo">139</span>        if (cascadeDeleteAttr != null)<a name="line.139"></a>
<span class="sourceLineNo">140</span>            this.setCascadeDelete(cascadeDeleteAttr);<a name="line.140"></a>
<span class="sourceLineNo">141</span>    }<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span>    @Override<a name="line.143"></a>
<span class="sourceLineNo">144</span>    void readSubElements(XMLStreamReader reader, int formatVersion) throws XMLStreamException {<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span>        // Any restrictions?<a name="line.146"></a>
<span class="sourceLineNo">147</span>        if (!this.expect(reader, true, OBJECT_TYPES_TAG)) {<a name="line.147"></a>
<span class="sourceLineNo">148</span>            this.objectTypes = null;<a name="line.148"></a>
<span class="sourceLineNo">149</span>            return;<a name="line.149"></a>
<span class="sourceLineNo">150</span>        }<a name="line.150"></a>
<span class="sourceLineNo">151</span><a name="line.151"></a>
<span class="sourceLineNo">152</span>        // Read list of zero or more permitted storage ID<a name="line.152"></a>
<span class="sourceLineNo">153</span>        this.objectTypes = new TreeSet&lt;&gt;();<a name="line.153"></a>
<span class="sourceLineNo">154</span>        while (this.expect(reader, true, OBJECT_TYPE_TAG)) {<a name="line.154"></a>
<span class="sourceLineNo">155</span>            this.objectTypes.add(this.getIntAttr(reader, STORAGE_ID_ATTRIBUTE));<a name="line.155"></a>
<span class="sourceLineNo">156</span>            this.expectClose(reader);           // &lt;/ObjectType&gt;<a name="line.156"></a>
<span class="sourceLineNo">157</span>        }<a name="line.157"></a>
<span class="sourceLineNo">158</span><a name="line.158"></a>
<span class="sourceLineNo">159</span>        // Read closing &lt;/ReferenceField&gt;<a name="line.159"></a>
<span class="sourceLineNo">160</span>        this.expectClose(reader);<a name="line.160"></a>
<span class="sourceLineNo">161</span>    }<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span>// XML Writing<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span>    @Override<a name="line.165"></a>
<span class="sourceLineNo">166</span>    void writeXML(XMLStreamWriter writer, boolean includeName) throws XMLStreamException {<a name="line.166"></a>
<span class="sourceLineNo">167</span>        if (this.objectTypes != null)<a name="line.167"></a>
<span class="sourceLineNo">168</span>            writer.writeStartElement(REFERENCE_FIELD_TAG.getNamespaceURI(), REFERENCE_FIELD_TAG.getLocalPart());<a name="line.168"></a>
<span class="sourceLineNo">169</span>        else<a name="line.169"></a>
<span class="sourceLineNo">170</span>            writer.writeEmptyElement(REFERENCE_FIELD_TAG.getNamespaceURI(), REFERENCE_FIELD_TAG.getLocalPart());<a name="line.170"></a>
<span class="sourceLineNo">171</span>        this.writeAttributes(writer, includeName);<a name="line.171"></a>
<span class="sourceLineNo">172</span>        if (this.onDelete != null)<a name="line.172"></a>
<span class="sourceLineNo">173</span>            writer.writeAttribute(ON_DELETE_ATTRIBUTE.getNamespaceURI(), ON_DELETE_ATTRIBUTE.getLocalPart(), this.onDelete.name());<a name="line.173"></a>
<span class="sourceLineNo">174</span>        if (this.objectTypes != null) {<a name="line.174"></a>
<span class="sourceLineNo">175</span>            writer.writeStartElement(OBJECT_TYPES_TAG.getNamespaceURI(), OBJECT_TYPES_TAG.getLocalPart());<a name="line.175"></a>
<span class="sourceLineNo">176</span>            for (int storageId : this.objectTypes) {<a name="line.176"></a>
<span class="sourceLineNo">177</span>                writer.writeEmptyElement(OBJECT_TYPE_TAG.getNamespaceURI(), OBJECT_TYPE_TAG.getLocalPart());<a name="line.177"></a>
<span class="sourceLineNo">178</span>                writer.writeAttribute(STORAGE_ID_ATTRIBUTE.getNamespaceURI(), STORAGE_ID_ATTRIBUTE.getLocalPart(), "" + storageId);<a name="line.178"></a>
<span class="sourceLineNo">179</span>            }<a name="line.179"></a>
<span class="sourceLineNo">180</span>            writer.writeEndElement();           // &lt;/ObjectTypes&gt;<a name="line.180"></a>
<span class="sourceLineNo">181</span>            writer.writeEndElement();           // &lt;/ReferenceField&gt;<a name="line.181"></a>
<span class="sourceLineNo">182</span>        }<a name="line.182"></a>
<span class="sourceLineNo">183</span>    }<a name="line.183"></a>
<span class="sourceLineNo">184</span><a name="line.184"></a>
<span class="sourceLineNo">185</span>    @Override<a name="line.185"></a>
<span class="sourceLineNo">186</span>    void writeSimpleAttributes(XMLStreamWriter writer) throws XMLStreamException {<a name="line.186"></a>
<span class="sourceLineNo">187</span>        // don't need to write type or indexed<a name="line.187"></a>
<span class="sourceLineNo">188</span>        if (this.cascadeDelete) {<a name="line.188"></a>
<span class="sourceLineNo">189</span>            writer.writeAttribute(CASCADE_DELETE_ATTRIBUTE.getNamespaceURI(), CASCADE_DELETE_ATTRIBUTE.getLocalPart(),<a name="line.189"></a>
<span class="sourceLineNo">190</span>              "" + this.cascadeDelete);<a name="line.190"></a>
<span class="sourceLineNo">191</span>        }<a name="line.191"></a>
<span class="sourceLineNo">192</span>    }<a name="line.192"></a>
<span class="sourceLineNo">193</span><a name="line.193"></a>
<span class="sourceLineNo">194</span>// Object<a name="line.194"></a>
<span class="sourceLineNo">195</span><a name="line.195"></a>
<span class="sourceLineNo">196</span>    @Override<a name="line.196"></a>
<span class="sourceLineNo">197</span>    public boolean equals(Object obj) {<a name="line.197"></a>
<span class="sourceLineNo">198</span>        if (obj == this)<a name="line.198"></a>
<span class="sourceLineNo">199</span>            return true;<a name="line.199"></a>
<span class="sourceLineNo">200</span>        if (!super.equals(obj))<a name="line.200"></a>
<span class="sourceLineNo">201</span>            return false;<a name="line.201"></a>
<span class="sourceLineNo">202</span>        final ReferenceSchemaField that = (ReferenceSchemaField)obj;<a name="line.202"></a>
<span class="sourceLineNo">203</span>        return this.onDelete == that.onDelete<a name="line.203"></a>
<span class="sourceLineNo">204</span>          &amp;&amp; this.cascadeDelete == that.cascadeDelete<a name="line.204"></a>
<span class="sourceLineNo">205</span>          &amp;&amp; (this.objectTypes != null ? this.objectTypes.equals(that.objectTypes) : that.objectTypes == null);<a name="line.205"></a>
<span class="sourceLineNo">206</span>    }<a name="line.206"></a>
<span class="sourceLineNo">207</span><a name="line.207"></a>
<span class="sourceLineNo">208</span>    @Override<a name="line.208"></a>
<span class="sourceLineNo">209</span>    public int hashCode() {<a name="line.209"></a>
<span class="sourceLineNo">210</span>        return super.hashCode()<a name="line.210"></a>
<span class="sourceLineNo">211</span>          ^ (this.cascadeDelete ? 1 : 0)<a name="line.211"></a>
<span class="sourceLineNo">212</span>          ^ (this.onDelete != null ? this.onDelete.hashCode() : 0)<a name="line.212"></a>
<span class="sourceLineNo">213</span>          ^ (this.objectTypes != null ? this.objectTypes.hashCode() : 0);<a name="line.213"></a>
<span class="sourceLineNo">214</span>    }<a name="line.214"></a>
<span class="sourceLineNo">215</span><a name="line.215"></a>
<span class="sourceLineNo">216</span>// Cloneable<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span>    @Override<a name="line.218"></a>
<span class="sourceLineNo">219</span>    public ReferenceSchemaField clone() {<a name="line.219"></a>
<span class="sourceLineNo">220</span>        final ReferenceSchemaField clone = (ReferenceSchemaField)super.clone();<a name="line.220"></a>
<span class="sourceLineNo">221</span>        if (clone.objectTypes != null)<a name="line.221"></a>
<span class="sourceLineNo">222</span>            clone.objectTypes = new TreeSet&lt;Integer&gt;(clone.objectTypes);<a name="line.222"></a>
<span class="sourceLineNo">223</span>        return clone;<a name="line.223"></a>
<span class="sourceLineNo">224</span>    }<a name="line.224"></a>
<span class="sourceLineNo">225</span>}<a name="line.225"></a>
<span class="sourceLineNo">226</span><a name="line.226"></a>




























































</pre>
</div>
</body>
</html>
